home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / lib / perl5 / Gtk2.pm < prev    next >
Encoding:
Perl POD Document  |  2009-07-04  |  12.7 KB  |  426 lines
  1. #
  2. # Copyright (C) 2003-2008 by the gtk2-perl team (see the file AUTHORS for
  3. # the full list)
  4. #
  5. # This library is free software; you can redistribute it and/or modify it under
  6. # the terms of the GNU Library General Public License as published by the Free
  7. # Software Foundation; either version 2.1 of the License, or (at your option)
  8. # any later version.
  9. #
  10. # This library is distributed in the hope that it will be useful, but WITHOUT
  11. # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12. # FOR A PARTICULAR PURPOSE.  See the GNU Library General Public License for
  13. # more details.
  14. #
  15. # You should have received a copy of the GNU Library General Public License
  16. # along with this library; if not, write to the Free Software Foundation, Inc.,
  17. # 59 Temple Place - Suite 330, Boston, MA  02111-1307  USA.
  18. #
  19. # $Id$
  20. #
  21.  
  22. package Gtk2;
  23.  
  24. # Gtk uses unicode strings; thus we require perl>=5.8.x,
  25. # which is unicode internally.
  26. use 5.008;
  27. use strict;
  28. use warnings;
  29.  
  30. use Glib;
  31. use Pango;
  32.  
  33. # Backwards compatibility: create Gtk2::Pango aliases for everything in Pango
  34. # that was originally in Gtk2::Pango.
  35. {
  36.   no strict 'refs';
  37.   my @pango_keys = qw(
  38.     AttrBackground:: AttrColor:: AttrFallback:: AttrFamily:: AttrFontDesc::
  39.     AttrForeground:: AttrGravity:: AttrGravityHint:: Attribute:: AttrInt::
  40.     AttrIterator:: AttrLanguage:: AttrLetterSpacing:: AttrList:: AttrRise::
  41.     AttrScale:: AttrShape:: AttrSize:: AttrStretch:: AttrStrikethrough::
  42.     AttrStrikethroughColor:: AttrString:: AttrStyle:: AttrUnderline::
  43.     AttrUnderlineColor:: AttrVariant:: AttrWeight:: Cairo:: Color:: Context::
  44.     Font:: FontDescription:: FontFace:: FontFamily:: FontMap:: FontMask::
  45.     FontMetrics:: Fontset:: GlyphString:: Gravity:: Language:: Layout::
  46.     LayoutIter:: LayoutLine:: Matrix:: Renderer:: Script:: ScriptIter::
  47.     TabArray::
  48.  
  49.     extents_to_pixels find_base_dir parse_markup pixels scale scale_large
  50.     scale_medium scale_small scale_x_large scale_x_small scale_xx_large
  51.     scale_xx_small units_from_double units_to_double
  52.  
  53.     PANGO_PIXELS
  54.  
  55.     CHECK_VERSION GET_VERSION_INFO VERSION
  56.  
  57.     ISA
  58.   );
  59.   foreach my $key (@pango_keys) {
  60.     # Avoid warnings about names that are used only once by checking for
  61.     # definedness here.
  62.     if (defined *{'Pango::' . $key}) {
  63.       *{'Gtk2::Pango::' . $key} = *{'Pango::' . $key};
  64.     }
  65.   }
  66. }
  67.  
  68. # if the gtk+ we've been compiled against is at 2.8.0 or newer or if pango is
  69. # at 1.10.0 or newer, we need to import the Cairo module for the cairo glue in
  70. # gtk+ and pango.
  71. eval "use Cairo;";
  72.  
  73. use Exporter;
  74. require DynaLoader;
  75.  
  76. our $VERSION = '1.221';
  77.  
  78. our @ISA = qw(DynaLoader Exporter);
  79.  
  80. # this is critical -- tell dynaloader to load the module so that its
  81. # symbols are available to all other modules.  without this, nobody
  82. # else can use important functions like gtk2perl_new_object!
  83. #
  84. # hrm.  win32 doesn't really use this, because we have to link the whole
  85. # thing at compile time to ensure all the symbols are defined.
  86. #
  87. # on darwin, at least with the particular 5.8.0 binary i'm using, perl
  88. # complains "Can't make loaded symbols global on this platform" when this
  89. # is set to 0x01, but goes on to work fine.  returning 0 here avoids the
  90. # warning and doesn't appear to break anything.
  91. sub dl_load_flags { $^O eq 'darwin' ? 0x00 : 0x01 }
  92.  
  93. # now load the XS code.
  94. Gtk2->bootstrap ($VERSION);
  95.  
  96. # %Gtk2::EXPORT_TAGS is filled from the constants-x.y files by the generated XS
  97. # code in build/constants.xs
  98. our @EXPORT_OK = map { @$_ } values %Gtk2::EXPORT_TAGS;
  99. $Gtk2::EXPORT_TAGS{all} = \@EXPORT_OK;
  100.  
  101. # Names "STOP" and "PROPAGATE" here are per the GtkWidget event signal
  102. # descriptions.  In some other flavours of signals the jargon is "handled"
  103. # instead of "stop".  "Handled" matches g_signal_accumulator_true_handled(),
  104. # though that function doesn't rate a mention in the Gtk docs.  There's
  105. # nothing fixed in the idea of "true means cease emission" (whether it's
  106. # called "stop" or "handled").  You can just as easily have false for cease
  107. # (the way the underlying GSignalAccumulator func in fact operates).  The
  108. # upshot being don't want to attempt to be too universal with the names
  109. # here; "EVENT" is meant to hint at the context or signal flavour they're
  110. # for use with.
  111. use constant {
  112.   EVENT_STOP      => 1,
  113.   EVENT_PROPAGATE => !1,
  114. };
  115.  
  116. sub import {
  117.     my $class = shift;
  118.  
  119.     # threads' init needs to be called before the main init and we don't
  120.     # want to force the order those options are passed to us so we need to
  121.     # cache the choices in booleans and (optionally) do them in the corect
  122.     # order afterwards
  123.     my $init = 0;
  124.     my $threads_init = 0;
  125.  
  126.     my @unknown_args = ($class);
  127.     foreach (@_) {
  128.         if (/^-?init$/) {
  129.             $init = 1;
  130.         } elsif (/-?threads-init$/) {
  131.             $threads_init = 1;
  132.         } else {
  133.             push @unknown_args, $_;
  134.         }
  135.     }
  136.  
  137.     Gtk2::Gdk::Threads->init if ($threads_init);
  138.     Gtk2->init if ($init);
  139.  
  140.     # call into Exporter for the unrecognized arguments; handles exporting
  141.     # and version checking
  142.     Gtk2->export_to_level (1, @unknown_args);
  143. }
  144.  
  145. # Preloaded methods go here.
  146.  
  147. package Gtk2::Gdk;
  148.  
  149. sub CHARS { 8 };
  150. sub SHORTS { 16 };
  151. sub LONGS { 32 };
  152.  
  153. sub USHORTS { 16 };
  154. sub ULONGS { 32 };
  155.  
  156. package Gtk2::Gdk::Atom;
  157.  
  158. use overload
  159.     '==' => \&Gtk2::Gdk::Atom::eq,
  160.     '!=' => \&Gtk2::Gdk::Atom::ne,
  161.     fallback => 1;
  162.  
  163. package Gtk2::CellLayout::DataFunc;
  164.  
  165. use overload
  166.     '&{}' => sub { \&Gtk2::CellLayout::DataFunc::invoke },
  167.     fallback => 1;
  168.  
  169. package Gtk2::TreeSortable::IterCompareFunc;
  170.  
  171. use overload
  172.     '&{}' => sub { \&Gtk2::TreeSortable::IterCompareFunc::invoke },
  173.     fallback => 1;
  174.  
  175. package Gtk2::TreeModelSort;
  176.  
  177. # We forgot to prepend Gtk2::TreeModel to @Gtk2::TreeModelSort::ISA.  So this
  178. # hack is here to make sure that $model_sort->get resolves to
  179. # Gtk2::TreeModel::get when appropriate and to Glib::Object::get otherwise, so
  180. # we stay backwards compatible.
  181. sub get {
  182.     if (@_ > 1 and ref $_[1] eq 'Gtk2::TreeIter') {
  183.         # called as $model->get ($iter, columns...);
  184.         return Gtk2::TreeModel::get (@_);
  185.     } else {
  186.         # called as $model->get (names...);
  187.         return Glib::Object::get (@_);
  188.     }
  189. }
  190.  
  191. package Gtk2::Builder;
  192.  
  193. sub _do_connect {
  194.   my ($object,
  195.       $signal_name,
  196.       $user_data,
  197.       $connect_object,
  198.       $flags,
  199.       $handler) = @_;
  200.  
  201.   my $func = ($flags & 'after') ? 'signal_connect_after' : 'signal_connect';
  202.  
  203.   # we get connect_object when we're supposed to call
  204.   # signal_connect_object, which ensures that the data (an object)
  205.   # lives as long as the signal is connected.  the bindings take
  206.   # care of that for us in all cases, so we only have signal_connect.
  207.   # if we get a connect_object, just use that instead of user_data.
  208.   $object->$func($signal_name => $handler,
  209.                  $connect_object ? $connect_object : $user_data);
  210. }
  211.  
  212. sub connect_signals {
  213.   my $builder = shift;
  214.   my $user_data = shift;
  215.  
  216.   # $builder->connect_signals ($user_data)
  217.   # $builder->connect_signals ($user_data, $package)
  218.   if ($#_ <= 0) {
  219.     my $package = shift;
  220.     $package = caller unless defined $package;
  221.  
  222.     $builder->connect_signals_full(sub {
  223.       my ($builder,
  224.           $object,
  225.           $signal_name,
  226.           $handler_name,
  227.           $connect_object,
  228.           $flags) = @_;
  229.  
  230.       no strict qw/refs/;
  231.  
  232.       my $handler = $handler_name;
  233.       if (ref $package) {
  234.         $handler = sub { $package->$handler_name(@_) };
  235.       } else {
  236.         if ($package && $handler !~ /::/) {
  237.           $handler = $package.'::'.$handler_name;
  238.         }
  239.       }
  240.  
  241.       _do_connect ($object, $signal_name, $user_data, $connect_object,
  242.                    $flags, $handler);
  243.     });
  244.   }
  245.  
  246.   # $builder->connect_signals ($user_data, %handlers)
  247.   else {
  248.     my %handlers = @_;
  249.  
  250.     $builder->connect_signals_full(sub {
  251.       my ($builder,
  252.           $object,
  253.           $signal_name,
  254.           $handler_name,
  255.           $connect_object,
  256.           $flags) = @_;
  257.  
  258.       return unless exists $handlers{$handler_name};
  259.  
  260.       _do_connect ($object, $signal_name, $user_data, $connect_object,
  261.                    $flags, $handlers{$handler_name});
  262.     });
  263.   }
  264. }
  265.  
  266. package Gtk2;
  267.  
  268. 1;
  269. __END__
  270. # documentation is a good thing.
  271.  
  272. =head1 NAME
  273.  
  274. Gtk2 - Perl interface to the 2.x series of the Gimp Toolkit library
  275.  
  276. =head1 SYNOPSIS
  277.  
  278.   use Gtk2 -init;
  279.   # Gtk2->init; works if you didn't use -init on use
  280.   my $window = Gtk2::Window->new ('toplevel');
  281.   my $button = Gtk2::Button->new ('Quit');
  282.   $button->signal_connect (clicked => sub { Gtk2->main_quit });
  283.   $window->add ($button);
  284.   $window->show_all;
  285.   Gtk2->main;
  286.  
  287. =head1 ABSTRACT
  288.  
  289. Perl bindings to the 2.x series of the Gtk+ widget set.  This module
  290. allows you to write graphical user interfaces in a Perlish and
  291. object-oriented way, freeing you from the casting and memory management
  292. in C, yet remaining very close in spirit to original API.
  293.  
  294. =head1 DESCRIPTION
  295.  
  296. The Gtk2 module allows a Perl developer to use the Gtk+ graphical user
  297. interface library.  Find out more about Gtk+ at http://www.gtk.org.
  298.  
  299. The GTK+ Reference Manual is also a handy companion when writing Gtk
  300. programs in any language.  http://developer.gnome.org/doc/API/2.0/gtk/
  301. The Perl bindings follow the C API very closely, and the C reference
  302. documentation should be considered the canonical source.
  303.  
  304. To discuss gtk2-perl, ask questions and flame/praise the authors,
  305. join gtk-perl-list@gnome.org at lists.gnome.org.
  306.  
  307. Also have a look at the gtk2-perl website and sourceforge project page,
  308. http://gtk2-perl.sourceforge.net
  309.  
  310. =head1 INITIALIZATION
  311.  
  312.   use Gtk2 qw/-init/;
  313.   use Gtk2 qw/-init -threads-init/;
  314.  
  315. =over
  316.  
  317. =item -init
  318.  
  319. Equivalent to Gtk2->init, called to initialize GLIB and GTK+. Just about every
  320. Gtk2-Perl script should do "use Gtk2 -init"; This initialization should take
  321. place before using any other Gtk2 functions in your GUI applications. It will
  322. initialize everything needed to operate the toolkit and parses some standard
  323. command line options. @ARGV is adjusted accordingly so your own code will never
  324. see those standard arguments.
  325.  
  326. =item -threads-init
  327.  
  328. Equivalent to Gtk2::Gdk::Threads->init, called to initialze/enable gdk's thread
  329. safety mechanisms so that gdk can be accessed from multiple threads when used
  330. in conjunction with Gtk2::Gdk::Threads->enter and Gtk2::Gdk::Threads->leave. If
  331. invoked as Gtk2::Gdk::Threads->init it should be done before Gtk2->init is
  332. called, if done by "use Gtk2 -init -threads-init" order does not matter.
  333.  
  334. =back
  335.  
  336. =head1 EXPORTS
  337.  
  338. Gtk2 exports nothing by default, but some constants are available upon request.
  339.  
  340. =over
  341.  
  342. =item Tag: constants
  343.  
  344.   GTK_PRIORITY_RESIZE
  345.  
  346.   GTK_PATH_PRIO_LOWEST
  347.   GTK_PATH_PRIO_GTK
  348.   GTK_PATH_PRIO_APPLICATION
  349.   GTK_PATH_PRIO_THEME
  350.   GTK_PATH_PRIO_RC
  351.   GTK_PATH_PRIO_HIGHEST
  352.  
  353.   GDK_PRIORITY_EVENTS
  354.   GDK_PRIORITY_REDRAW
  355.   GDK_CURRENT_TIME
  356.  
  357. =back
  358.  
  359. See L<Glib> for other standard priority levels.
  360.  
  361. =head1 SEE ALSO
  362.  
  363. L<perl>(1), L<Glib>(3pm), L<Pango>(3pm).
  364.  
  365. L<Gtk2::Gdk::Keysyms>(3pm) contains a hash of key codes, culled from
  366. gdk/gdkkeysyms.h
  367.  
  368. L<Gtk2::api>(3pm) describes how to map the C API into Perl, and some of the
  369. important differences in the Perl bindings.
  370.  
  371. L<Gtk2::Helper>(3pm) contains stuff that makes writing Gtk2 programs
  372. a little easier.
  373.  
  374. L<Gtk2::SimpleList>(3pm) makes the GtkListStore and GtkTreeModel a I<lot>
  375. easier to use.
  376.  
  377. L<Gtk2::Pango>(3pm) exports various little-used but important constants you
  378. may need to work with pango directly.
  379.  
  380. L<Gtk2::index>(3pm) lists the autogenerated api documentation pod files
  381. for Gtk2.
  382.  
  383. Gtk2 also provides code to make it relatively painless to create Perl
  384. wrappers for other GLib/Gtk-based libraries.  See L<Gtk2::CodeGen>,
  385. L<ExtUtils::PkgConfig>, and L<ExtUtils::Depends>.  If you're writing bindings,
  386. you'll probably also be interested in L<Gtk2::devel>, which is a supplement
  387. to L<Glib::devel> and L<Glib::xsapi>.  The Binding Howto, at
  388. http://gtk2-perl.sourceforge.net/doc/binding_howto.pod.html, ties it all
  389. together.
  390.  
  391. =head1 AUTHORS
  392.  
  393. =encoding utf8
  394.  
  395. The gtk2-perl team:
  396.  
  397.  muppet <scott at asofyet dot org>
  398.  Ross McFarland <rwmcfa1 at neces dot com>
  399.  Torsten Schoenfeld <kaffeetisch at web dot de>
  400.  Marc Lehmann <pcg at goof dot com>
  401.  G├╢ran Thyni <gthyni at kirra dot net>
  402.  J├╢rn Reder <joern at zyn dot de>
  403.  Chas Owens <alas at wilma dot widomaker dot com>
  404.  Guillaume Cottenceau <gc at mandrakesoft dot com>
  405.  
  406. =head1 COPYRIGHT AND LICENSE
  407.  
  408. Copyright 2003-2008 by the gtk2-perl team.
  409.  
  410. This library is free software; you can redistribute it and/or
  411. modify it under the terms of the GNU Library General Public
  412. License as published by the Free Software Foundation; either
  413. version 2 of the License, or (at your option) any later version.
  414.  
  415. This library is distributed in the hope that it will be useful,
  416. but WITHOUT ANY WARRANTY; without even the implied warranty of
  417. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  418. Library General Public License for more details.
  419.  
  420. You should have received a copy of the GNU Library General Public
  421. License along with this library; if not, write to the
  422. Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  423. Boston, MA  02111-1307  USA.
  424.  
  425. =cut
  426.